Skip to main content

Find-IMPerson

SYNOPSIS​

Searches for people by name or visibility.

SYNTAX​

Find-IMPerson [[-Session] <ImmichSession>] [-Name] <String> [[-WithHidden] <Boolean>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Finds person records using name filtering and hidden status options.

EXAMPLES​

EXAMPLE 1​

Find-IMPerson -Name 'John'

Searches for people with 'John' in their name.

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name​

Search by person name (supports partial matches).

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WithHidden​

Include hidden people when $true, exclude when $false.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github